<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>File: README</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



  <div id="fileHeader">
    <h1>README</h1>
    <table class="header-table">
    <tr class="top-aligned-row">
      <td><strong>Path:</strong></td>
      <td>README
      </td>
    </tr>
    <tr class="top-aligned-row">
      <td><strong>Last Update:</strong></td>
      <td>Mon Aug 29 22:16:39 PDT 2005</td>
    </tr>
    </table>
  </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">

    <div id="description">
      <h2>Welcome to Simple RSS</h2>
<p>
Simple RSS is a simple, flexible, extensible, and liberal RSS and Atom
reader for Ruby. It is designed to be backwards compatible with the
standard RSS parser, but will never do RSS generation.
</p>
<h2>Download</h2>
<ul>
<li>gem install simple-rss

</li>
<li><a
href="http://rubyforge.org/projects/simple-rss">rubyforge.org/projects/simple-rss</a>

</li>
<li>svn co <a
href="http://rufy.com/svn/simple-rss/trunk">rufy.com/svn/simple-rss/trunk</a>

</li>
</ul>
<h3>Usage</h3>
<p>
The API is similar to Ruby&#8217;s standard RSS parser:
</p>
<pre>
    require 'rubygems'
    require 'simple-rss'
    require 'open-uri'

    rss = SimpleRSS.parse open('http://slashdot.org/index.rdf')

    rss.channel.title # =&gt; &quot;Slashdot&quot;
    rss.channel.link # =&gt; &quot;http://slashdot.org/&quot;
    rss.items.first.link # =&gt; &quot;http://books.slashdot.org/article.pl?sid=05/08/29/1319236&amp;amp;from=rss&quot;
</pre>
<p>
But since the parser can read Atom feeds as easily as RSS feeds, there are
optional aliases that allow more atom like reading:
</p>
<pre>
    rss.feed.title # =&gt; &quot;Slashdot&quot;
    rss.feed.link # =&gt; &quot;http://slashdot.org/&quot;
    rss.entries.first.link # =&gt; &quot;http://books.slashdot.org/article.pl?sid=05/08/29/1319236&amp;amp;from=rss&quot;
</pre>
<p>
The parser does not care about the correctness of the XML as it does not
use an XML library to read the information. Thus it is flexible and allows
for easy extending via:
</p>
<pre>
   SimpleRSS.feed_tags &lt;&lt; :some_new_tag
</pre>
<h2>Authors</h2>
<ul>
<li>Lucas Carlson (<a href="mailto:lucas@rufy.com">lucas@rufy.com</a>)

</li>
</ul>
<p>
Inspired by Blagg (<a
href="http://www.raelity.org/lang/perl/blagg">www.raelity.org/lang/perl/blagg</a>)
from Rael Dornfest.
</p>
<p>
This library is released under the terms of the GNU LGPL.
</p>

    </div>


   </div>


  </div>


    <!-- if includes -->

    <div id="section">





      


    <!-- if method_list -->


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>